/*
 * Copyright (C) 2011 by Fabien Barbero
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.flickr.api.galleries;

import com.flickr.api.IdentifiedObject;
import com.flickr.api.photos.Photo;
import java.net.URL;
import java.util.Date;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlTransient;

/**
 *
 * @author Fabien Barbero
 */
public class Gallery implements IdentifiedObject {
    
    @XmlAttribute(name="id")
    private String id;
    
    @XmlAttribute(name="url")
    private URL url;
    
    @XmlAttribute(name="owner")
    private String owner;
    
    @XmlAttribute(name="date_create")
    private Date creation;
    
    @XmlAttribute(name="date_update")
    private Date updated;
    
    @XmlAttribute(name="primary_photo_id")
    private String primaryPhotoId;
    
    @XmlAttribute(name="primary_photo_server")
    private String primaryPhotoServer;
    
    @XmlAttribute(name="primary_photo_farm")
    private int primaryPhotoFarm;
    
    @XmlAttribute(name="primary_photo_secret")
    private String primaryPhotoSecret;
    
    @XmlAttribute(name="count_photos")
    private int countPhotos;
    
    @XmlAttribute(name="count_videos")
    private int countVideos;
    
    @XmlElement(name="title")
    private String title;
    
    @XmlElement(name="description")
    private String description;
    
    @XmlTransient
    private Photo primPhoto;
    
    
    Gallery() {}

    @Override
    public String getId() {
        return id;
    }

    /**
     * Get the number of photos of the collection.
     * @return The number of photos.
     */
    public int getCountPhotos() {
        return countPhotos;
    }

    /**
     * Get the number of videos of the collection.
     * @return The number of videos.
     */
    public int getCountVideos() {
        return countVideos;
    }

    /**
     * Get the creation date of the gallery.
     * @return The creation date.
     */
    public Date getCreationDate() {
        return creation;
    }

    /**
     * Get the description of the gallery.
     * @return The description.
     */
    public String getDescription() {
        return description;
    }

    /**
     * Get the owner of the gallery.
     * @return The owner.
     */
    public String getOwner() {
        return owner;
    }

    /**
     * Get the title of the gallery.
     * @return The title.
     */
    public String getTitle() {
        return title;
    }

    /**
     * Get the date of the last update of the gallery.
     * @return The last update date.
     */
    public Date getLastUpdatedDate() {
        return updated;
    }

    /**
     * Get the url of the gallery.
     * @return The url.
     */
    public URL getUrl() {
        return url;
    }
    
    public Photo getPrimaryPhoto() {
        if(primPhoto == null) {
            primPhoto = Photo.create(primaryPhotoId, primaryPhotoServer, primaryPhotoFarm, primaryPhotoSecret);
        }
        return primPhoto;
    }
    
}
